﻿/*----------------------------------------------------------------
//  <copyright file="IRoleOrganizationStore.cs" company="MicroCloud@151504200868">
//      Copyright © 2020-2024 MicroCloud Corporation, All rights reserved.
//  </copyright>
//  <site>https://gitee.com/chenmm123/microclouds</site>
//  <last-editor>cmm</last-editor>
//  <last-date>2022-12-23 13:06</last-date>
//----------------------------------------------------------------*/

namespace MicroCloud.Identity
{
    #region "为将角色映射到组织机构的存储提供抽象"
    /// <summary>
    /// 为将角色映射到组织机构的存储提供抽象
    /// </summary>
    /// <typeparam name="TRole">角色实体类型</typeparam>
    public interface IRoleOrganizationStore<TRole> : IRoleStore<TRole>, IDisposable
        where TRole : class
    {
        #region "方法"
        #region "将指定的角色添加到组织机构"
        /// <summary>
        /// 将指定的角色添加到组织机构
        /// </summary>
        /// <param name="role">角色数据</param>
        /// <param name="organizationId">组织机构编号</param>
        /// <param name="cancellationToken">用于传播应取消操作的通知</param>
        /// <returns><see cref="Task" />表示一个异步的<see cref="OperationResult" /></returns>
        Task<OperationResult> AddToOrganizationAsync(TRole role, string organizationId, CancellationToken cancellationToken = new CancellationToken());
        #endregion
        #region "将指定的角色添加到组织机构集合"
        /// <summary>
        /// 将指定的角色添加到组织机构集合
        /// </summary>
        /// <param name="role">角色数据</param>
        /// <param name="organizationIds">组织机构编号集合</param>
        /// <param name="cancellationToken">用于传播应取消操作的通知</param>
        /// <returns><see cref="Task" />表示一个异步的<see cref="OperationResult" /></returns>
        Task<OperationResult> AddToOrganizationsAsync(TRole role, string[] organizationIds, CancellationToken cancellationToken = new CancellationToken());
        #endregion
        #region "从组织机构中删除指定的角色"
        /// <summary>
        /// 从组织机构中删除指定的角色
        /// </summary>
        /// <param name="role">角色数据</param>
        /// <param name="organizationId">组织机构编号</param>
        /// <param name="cancellationToken">用于传播应取消操作的通知</param>
        /// <returns><see cref="Task" />表示一个异步的<see cref="OperationResult" /></returns>
        Task<OperationResult> RemoveFromOrganizationAsync(TRole role, string organizationId, CancellationToken cancellationToken = new CancellationToken());
        #endregion
        #region "从组织机构集合中删除指定的角色"
        /// <summary>
        /// 从组织机构集合中删除指定的角色
        /// </summary>
        /// <param name="role">角色数据</param>
        /// <param name="organizationIds">组织机构编号集合</param>
        /// <param name="cancellationToken">用于传播应取消操作的通知</param>
        /// <returns><see cref="Task" />表示一个异步的<see cref="OperationResult" /></returns>
        Task<OperationResult> RemoveFromOrganizationsAsync(TRole role, string[] organizationIds, CancellationToken cancellationToken = new CancellationToken());
        #endregion
        #region "获取指定角色所属的组织机构编号列表"
        /// <summary>
        /// 获取指定角色所属的组织机构编号列表
        /// </summary>
        /// <param name="role">角色数据</param>
        /// <param name="cancellationToken">用于传播应取消操作的通知</param>
        /// <returns>包含组织机构编号集合的<see cref="Task" />结果</returns>
        Task<IList<string>> GetOrganizationsAsync(TRole role, CancellationToken cancellationToken = new CancellationToken());
        #endregion
        #region "返回一个标志，指示指定的角色是否为给定组织机构的成员"
        /// <summary>
        /// 返回一个标志，指示指定的角色是否为给定组织机构的成员
        /// </summary>
        /// <param name="role">角色数据</param>
        /// <param name="organizationId">组织机构编号</param>
        /// <param name="cancellationToken">用于传播应取消操作的通知</param>
        /// <returns>包含布尔值的<see cref="Task" />结果</returns>
        Task<bool> IsInOrganizationAsync(TRole role, string organizationId, CancellationToken cancellationToken = new CancellationToken());
        #endregion
        #region "返回作为组织机构成员的角色列表"
        /// <summary>
        /// 返回作为组织机构成员的角色列表
        /// </summary>
        /// <param name="organizationId">组织机构编号</param>
        /// <param name="cancellationToken">用于传播应取消操作的通知</param>
        /// <returns>包含角色集合的<see cref="Task" />结果</returns>
        Task<IList<TRole>> GetRolesInOrganizationAsync(string organizationId, CancellationToken cancellationToken = new CancellationToken());
        #endregion

        #endregion

    }
    #endregion

}
